home *** CD-ROM | disk | FTP | other *** search
/ Revista CD Expert 8 / Revista CD Expert nº 08 CD1.iso / Utilitarios / Programacao / MS-DOS Interrupt List / inter60f / INT2WHLP.ZIP / I2W-HINT.TXT < prev    next >
Text File  |  1998-11-10  |  14KB  |  339 lines
  1. This is a sort of a guide to using the INT2WHLP precompiler. INT2WHLP
  2. transfers Ralf Brown's Interrupt List to some RTF (Rich-Text Format) files
  3. which can be used as input for Microsoft's HC31 WINHELP file compiler.
  4.  
  5. This text gives also some hints on using the the results of the compilation.
  6.  
  7.  
  8. COMPILATION
  9.  
  10. The easy way to compile the list is this:
  11.  
  12. Change to the directory where you want your INTWIN.HLP file. There should
  13. be at least 16 Mb free space on the disk. It can be the directory with the
  14. Interrupt List files (which we will call the Source Directory), but it is
  15. better to use a separate directory not to mess up the Source Directory. A
  16. subdirectory under the Source Directory would be fine. Copy the following
  17. files to the directory:
  18.     INTWIN.BAT
  19.     INT2WHLP.EXE
  20.     INT2WHLP.CFG
  21.     SHORTKEY.RTF (if program option -l- is used)
  22.     FLT_METH.RTF (if program option -f<filter> is used)
  23.     TABLEKWT.RTF (if program option -kt is used)
  24.     SECKEY.DLL   (if program option -kt is used)
  25.     SEL_TOPC.RTF
  26.     MISC_INF.RTF
  27.     I2W_HH.RTF
  28.     HS_INIT.RTF
  29.     INTWIN.PH    (see section COMPRESSION)
  30.     INTERRUP.ICO (see section ICON)
  31.     BAG.INI
  32. It is handy also to have:
  33.     I2W-FILE.TXT
  34.     I2W-HINT.TXT (this file)
  35.     I2W-CFG.TXT
  36.     I2W-OPT.TXT
  37. in the directory. For a partial compilation of the List, FLT_METH.RTF is
  38. required (see paragraph FLT_METH.RTF in I2W-FILE.TXT).
  39.  
  40. Make sure that the following files are in the Source Directory:
  41.     INTERRUP.LST or INTERRUP.A, INTERRUP.B, ...
  42.     INTERRUP.1ST
  43.     CATEGORY.KEY
  44.     OVERVIEW.LST
  45.     INTERRUP.PRI
  46.     PORTS.LST
  47.     MEMORY.LST
  48.     CMOS.LST
  49.     GLOSSARY.LST
  50. where INTERRUP.LST is the concatenation of INTERRUP.A, INTERRUP.B, ... .
  51.  
  52. Make sure that HC31.EXE is somewhere on the DOS path.
  53.  
  54. Type
  55.     INTWIN
  56.        (INTWIN -R58 to compile a list prior to release 59 with 4-digit tables)
  57. at the DOS prompt to start the compilation. On a 486/33MHz computer it
  58. takes INT2WHLP 1 1/2 minut to precompile release 41 of the List, and it
  59. takes HC31 40 minutes to create the INTWIN.HLP file.
  60.  
  61. Parameters to INTWIN will be passed to INT2WHLP, thus a compilation with
  62. only the compressed interrupt index can be made with
  63.     INTWIN -2-
  64. This will reduce the size of the resulting help file from about 5 Mb to
  65. about 4.85 Mb (release 44).
  66.  
  67. The configuration file in release 49+ disables the long version of interrupt
  68. search keys, to reduce the number of keywords and enable keyword searching in
  69. WinHelp version 4.00 (coming with Windows 95), which has a limited keyword
  70. capacity. If you are using WinHelp 3.10 or 3.11, you can override the
  71. disabling with
  72.     INTWIN -L+
  73.  
  74. Version 1.20 of INT2WHLP published in release 56 includes a facility that can
  75. conserve further space in the primary keyword table by moving table keywords
  76. (#nnnn) to a secondary table. This facility will not be enabled until INTWIN
  77. exceeds WinHelp's keyword capacity. In can, however, be invoked with
  78.     INTWIN -KT
  79. and it can be disabled if it is already invoked in the configuration file with
  80.     INTWIN -KT-
  81.  
  82.  
  83. PROBLEMS
  84.  
  85. It has happened that the Interrupt List was changed so INT2WHLP failed to
  86. find aliases for some context strings. If this happens, a new INT2WHLP.CFG
  87. file will be included in INTERnnZ.ZIP (see COMPRESSION). If other errors
  88. occur during the compilation of the List, the README file in INTERnnZ.ZIP
  89. will give hints about how to solve the problem.
  90.  
  91. November 1998: The authors will no longer compile all the interrupt list
  92. releases, so you cannot expect immediate fixes and hints in a INTERnnZ.ZIP
  93. file.
  94.  
  95.  
  96. ERROR CODES
  97.  
  98. INT2WHLP returns errorlevel 240 - 245 if a fatal error occurs. It returns
  99. errorlevel 1 if one or more warnings are issued (inconsistent Interrupt
  100. List). The INTWIN batch file will let the user bail out (with ^C) if a
  101. warning errorlevel was returned from INT2WHLP's compilation of the List.
  102. It is recommended to terminate the batch file and fix the inconsistency in
  103. the Interrupt List, and compile again.
  104.  
  105.  
  106. CONFIGURATION
  107.  
  108. The INT2WHLP program lets you personalize your INTWIN.HLP file. If you use
  109. high resolution graphics on a large screen, then read the comments in the
  110. [CONFIG] section of the INT2WHLP.CFG file. For more details, see the files
  111. I2W-CFG.TXT and I2W-OPT.TXT.
  112.  
  113.  
  114. ICON
  115.  
  116. INT2WHLP will look for file INTERRUP.ICO in the following directories, and
  117. in this order:
  118.     The current directory (typically the user's own icon).
  119.     INT2WHLP's home directory.
  120.     The source directory (where INTERRUP.LST/INTERRUP.A ... resides)
  121.  
  122. If found, it will be included as an icon in the help file. It will then be
  123. shown in Windows 3.1 when INTWIN.HLP is minimized. It will not have any
  124. effect in Windows 95 (WinHelp v. 4.00.950). To use an interrup.ico icon to
  125. identify intwin.hlp, it must be defined as the icon in the shortcut to
  126. intwin.hlp.
  127.  
  128.  
  129. COMPRESSION
  130.  
  131. The HC31 program supports three levels of compression: high, medium, and
  132. none. Medium compressed and uncompressed files are about 15% and 100%
  133. longer than highly compressed files, respectively. HC31 can use an existing
  134. Phrases file (a .PH file with compression information), and it needs not to
  135. be exactly up-to-date. Compiling release 41 with a PH file from release 40
  136. gives a file about 4% longer than a compilation with an up-to-date PH file.
  137.  
  138. Compiling the compression information file is very resource consuming. For
  139. Interrupt List release 41 compiled with INT2WHLP v. 1.10:
  140.     631 kb < required DOS RAM < 730 kB
  141.     27 Mb < required free disk space < 50 Mb
  142. The compilation of the compression info took 20 minutes, and the rest of
  143. the compilation took 40 minutes on a 486/33MHx computer. Actually, when
  144. the computer gave up due to insufficient RAM when 631 kb were available,
  145. it had already created an INTWIN.PH file that was identical to the final
  146. file.
  147.  
  148. We will compile a Phrases file when a new list is released, and upload
  149. it to SimTel a day or two after the release of the List in file
  150. INTERnnZ.ZIP where nn is the List release number. See INTERRUP.1ST for
  151. SimTel mirror sites.
  152.  
  153. November 1998: The authors will no longer supply an INTERnnZ.ZIP file.
  154.  
  155.  
  156. HIGH RESOLUTION GRAPHICS
  157.  
  158. The default settings allow you to display the List on a normal 640x480 VGA
  159. screen without the need of horizontal scroll. If you use high resolution
  160. graphics on a large screen, you will want to define another size of the
  161. secondary window used to display the tables, see comments in the [CONFIG]
  162. section in file INT2WHLP.CFG.
  163.  
  164. The configuration file since Interrupt List release 56 changes the setting of
  165. the setting of secondary help window used for tables for better compatibility
  166. with 800x600 screens, and it can no longer be viewed on a 640x480 screen
  167. without scrolling, unless the configuration file is edited.
  168.  
  169. If you use a high resolution graphics on a screen with small dimensions, you
  170. might want to use a larger font. The file package I2W-TEST.ZIP contains files
  171. that let you experiment with different fonts with very short INT2WHLP and
  172. HC31 compilation times. Unzip the package to a subdirectory under your
  173. INT2WHLP directory and read its README file.
  174.  
  175. Tools are availabe to edit the position and size of the table window in an
  176. already compiled INTWIN.HLP file, e.g. WH_wEdit in the package WH_EDxxx.ZIP
  177. (xxx >= 111) in SimTel directory simtelnet/win3/winhelp.
  178.  
  179.  
  180. LIMITATIONS
  181.  
  182. DOS graphics characters where 176 <= code <= 223 are not converted to correct
  183. Windows equivalents. Horizontal and vertical single and double framing
  184. characters are converted to "-" and "|", and other graphics characters are
  185. converted to "+".
  186.  
  187. INT2WHLP cannot handle more than 63 per line of other characters with code
  188. > 126.
  189.  
  190.  
  191. WINHELP VERSION 4.00 LIMITATIONS
  192.  
  193. Version 4.00 of Microsoft's WinHelp program (coming with Windows 95) has a
  194. limited search index capacity. If the limit is exceeded, the search index
  195. window is left blank. Ways to enable keyword searching in Windows 95:
  196.     Complain to Microsoft about the limitaiton.
  197.     Use program option -L- to disable long interrupt search keys.
  198.     Reduce the number of extra files included in the compilation, or
  199.     include them as type 1 files rather than type 2 files (ports.lst and
  200.     memory.lst).
  201.     Use version 3.10/3.11 of WinHelp.exe.
  202.  
  203.  
  204. INTWIN's TOPIC SEARCH FACILITIES
  205.  
  206. INTWIN facilitates seaching interrupt topics with many different keys, based
  207. on:
  208.     a. Elements in the interrupt header line.
  209.     b. Keys in the file CATEGORY.KEY for the appropriate interrupt
  210.        category.
  211.     c. Combinations of interrupt number and register contents.
  212.     d. Category letters.
  213.  
  214. For example,
  215.  
  216. --------D-215E01CH00-----------------------------
  217. INT 21 - DOS 3.1+ network - SET MACHINE NAME
  218.     AX = 5E01h
  219.     CH = 00h undefine name (make it invalid)
  220.  
  221. will be listed with the following search keys:
  222.  
  223.     DOS 3.1+ network            \      a
  224.     SET MACHINE NAME            /
  225.     DOS kernal                  \ 
  226.     kernal (DOS)                 >     b
  227.     operating systems (DOS)     /
  228.     INT 21 AX = 5E01 CH = 00 5) \
  229.     INT 21 AX = 5E01         5)  \
  230.     INT 21 AH = 5E           5)   \
  231.     INT 21          1)       5)    \
  232.     21 5E01 CH00                    \
  233.     21 5E01                          > c
  234.     21 5E           2)              /
  235.     21              1)             /
  236.     AX = 5E01                     /
  237.     AH = 5E         3)           /
  238.     CH = 00                     /
  239.     D!              4)                 d
  240.  
  241. 1) WINHELP lists only the first 400 search hits.
  242. 2) The short form of an interrupt using AL to specify a function has two
  243.    leading dashes in the function number, e.g. the short form of
  244.    INT 2D AL = 10 is 2D --10.
  245.    Two dashes can be appended to the short form of an interrupt using AH for
  246.    funtion number, to distinguish the string from the more general string
  247.    used also as keyword for interrupts with the same value in the high part
  248.    of the AX register, e.g. 10 00-- will give less search hits than 10 00.
  249. 3) Use AH = nn to search for functions called with nn in AH or in the high
  250.    byte of AX. Use AX = nn-- to search for functions called with nn in AH and
  251.    no specific value in AL.
  252. 4) Because WINHELP's search facility does not distinguish between letter case,
  253.    the search keys for capital letter categories are the letter followed by
  254.    an exclamation mark.
  255. 5) Program option -l- and configuration file key longKeys=0 disable the long
  256.    interrupt search key.
  257.  
  258. TABLE CROSS-REFERENCES
  259.  
  260. Tables are separate topics in help files compiled with version 1.08+ of
  261. INT2WHLP. When referenced from a "#nnnn" hotspot, the table pops up in a
  262. secondary window, thus the user can easily change between the source in
  263. the main help window and the referenced table in the secondary window.
  264. However, secondary windows are less flexible than the main window: topics
  265. are not recorded in the history list, you cannot browse between topics (<<
  266. and >> pushbuttons), and the topics cannot be copied or printed from the
  267. secondary window. Therefore all tables have a "Copy to Main" hotspot at the
  268. top.
  269.  
  270. The table topic titles include the interrupt number and subfunction where
  271. the table is defined, and there is a hotspot at the end of each table that
  272. pops up the appropriate interrupt in the main window.
  273.  
  274. There are two search keys for each table topic: "#nnnn" where nnnn is the
  275. four digit table number, and the table title as given in the Interrupt List
  276. ("Bitfields for ...", "Call ... with:", "Format of ...", "Values for ...").
  277.  
  278. If option -KT is used all the #nnnn keywords are moved to a secondary
  279. keyword table and will not show up in the search dialog box. Use the key
  280. "#Table Search" to open a new dialog box and enter the table number there.
  281.  
  282.  
  283. FULL TEXT SEARCH FACILITIES
  284.  
  285. WinHelp's search facility offers search for predefined words or phrases.
  286. Various utilities offer full text search in help files, i.e. search the help
  287. file for any word or phrase the user specifies. These utilities are normally
  288. implememted as one or more dynamic link library files (DLLs), and macros are
  289. inserted in the help file to invoke the text search.
  290.  
  291. Oxford Computer Consultants include a special version of their FTS utility
  292. in the Interrupt List. To use the facility, copy HINTSRCH.DLL from Oxford
  293. Computer Consultants' program package HINTSRCH.ZIP to your Windows SYSTEM
  294. directory. INT2WHLP's configuration file inserts the proper macros in
  295. INTWIN.HLP. One of these macros inserts a "Find Text" pushbutton on
  296. WinHelp's button bar. HINTSRCH.DLL works only with INTWIN, see material in
  297. Oxford Computer Consultant's package for information about their products.
  298.  
  299. HINTSRCH.DLL is a 16 bits program, thus it is incompatible with Windows NT's
  300. WinHlp32.exe program, see IntWin/Help and Hints/Windows NT Users.
  301.  
  302. Also Microsoft offers an FTS kit. Microsoft's kit uses an index file causing
  303. the search to be extremely fast. A disadvantage is that it takes long time to
  304. compile the index file, and it occupies much disk space (it is 70% longer
  305. than INTWIN.HLP, 8.8 Mb vs. 5.2 Mb for Interrupt List release 45). For the
  306. benefit of those who have access to Microsoft's FTS kit and want to use it,
  307. INT2WHLP's configuration file inserts bag.ini as baggage in INTWIN.HLP, this
  308. file is required by the kit. Utilities are available that can edit the macros
  309. section of INTWIN.HLP to include the macros for Microsoft's kit (WH_wEdit,
  310. see section HIGH RESOLUTION GRAPHICS). The baggage causes no harm if it is 
  311. unused, and it occupies only about 100 bytes.
  312.  
  313. WinHelp under Windows 95 and Windows NT includes a full test search facility,
  314. however, Oxford Computer Consultants' HINTSRCH has several advantages
  315. compared to the built-in FTS. Most important, it lets the user step through
  316. the hits within each topic, whereas WinHelp's facility takes you only to the
  317. top of topics with hits.
  318.  
  319.  
  320. HELP WINDOW PUSHBUTTONS
  321.  
  322. The Help Window includes some extra shortcut pushbuttons.
  323.  
  324. "Print" sends the current topic to the currently selected printer. To select
  325. another printer, use "Print Select..." from the "File" menu.
  326.  
  327. "Copy" copies the current topic to the Cllipboard. To copy only part of the
  328. topic, use "Copy..." from the "Edit" menu.
  329.  
  330. "Exit" closes both the main window and an open secodary (table) window.
  331. Selecting "Close" from the control menu or pressing Alt F4 closes only the
  332. main window.
  333.  
  334. "Print" and "Exit" are equivalent to selecting "Print Topic" and "Exit" from
  335. the "File" menu.
  336.  
  337. "Find Text", see FULL TEXT SEARCH FACILITIES.
  338.  
  339.